Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 001 / telix.arc / TELIX.DOC < prev next >

Wrap

Text File | 1986-06-19 | 78.0 KB | 2,097 lines

Documentation for the Telix Communications Program v1.0 Copyright (c) 1986 by Colin Sampaleanu 276 Guildwood Parkway Scarborough, Ontario. M1E 1P9 Documentation for the Telix communications program COPYRIGHT NOTICE Telix is copyrighted (c) 1986 by Colin Sampaleanu. All rights are reserved. The program is distributed under the User Supported software concept. Non-registered users are allowed to use this program on a trial basis for a limited time., and are allowed to give it to others so that they may try it out as well. There are some restricitions: The program must be distributed in unmodified form, including documentation. Any modification of the original form of the program, including documentation, is illegal. The program must not be included with any other product for any reason whatsoever. There can not be any fee charged for the program, in any form, except for a disk handling fee of up to $5.00, which is allowed. If you have tried Telix and intend to use it on a regular basis, please consider registering and showing your support for the User Supported software concept. Documentation for the Telix communications program Table of Contents ----------------- User Supported Software . . . . . . . . . . . . . . . 1 Registration . . . . . . . . . . . . . . . . . . . . . 2 Introduction . . . . . . . . . . . . . . . . . . . . . 3 Program Description . . . . . . . . . . . . . . . . 3 The Telix Philosophy . . . . . . . . . . . . . . . . 3 Machine Requirements . . . . . . . . . . . . . . . . 3 Telix Files . . . . . . . . . . . . . . . . . . . . 3 Start-Up Directory . . . . . . . . . . . . . . . . . 3 Program Features . . . . . . . . . . . . . . . . . . . 5 Starting the Program . . . . . . . . . . . . . . . . 5 Output String Translation . . . . . . . . . . . . . 5 ConfigTX - the Configuration Program . . . . . . . . 5 Screen and Colour Settings . . . . . . . . . . . . 6 Modem and Dialing Settings . . . . . . . . . . . . 6 Filenames and Path Settings . . . . . . . . . . . 8 General Settings . . . . . . . . . . . . . . . . . 8 Kermit Parameters . . . . . . . . . . . . . . . . 9 The Dialing Directory . . . . . . . . . . . . . . . 9 The Help/Status Screen . . . . . . . . . . . . . . 9 The Dialing Directory . . . . . . . . . . . . . . . 9 Revising an Entry . . . . . . . . . . . . . . . . 10 Clearing an Entry . . . . . . . . . . . . . . . . 10 Revising Long Distance Codes . . . . . . . . . . . 10 Searching for an Entry . . . . . . . . . . . . . . 11 Dialing a Number . . . . . . . . . . . . . . . . . 11 Automatic Redial . . . . . . . . . . . . . . . . . . 11 File Transfers . . . . . . . . . . . . . . . . . . . 12 Downloading Files . . . . . . . . . . . . . . . . 12 Uploading Files . . . . . . . . . . . . . . . . . 12 File Transfer Protocols . . . . . . . . . . . . . 12 Script Files . . . . . . . . . . . . . . . . . . . . 13 Keyboard Macros . . . . . . . . . . . . . . . . . . 14 Dos Shell . . . . . . . . . . . . . . . . . . . . . 14 Editor . . . . . . . . . . . . . . . . . . . . . . . 14 Dos and File functions . . . . . . . . . . . . . . . 14 Files Directory . . . . . . . . . . . . . . . . . 15 Change Directory . . . . . . . . . . . . . . . . . 15 Change Drive . . . . . . . . . . . . . . . . . . . 15 Delete File . . . . . . . . . . . . . . . . . . . 15 Session Logging . . . . . . . . . . . . . . . . . . 15 Scroll-Back . . . . . . . . . . . . . . . . . . . . 15 Clear Screen . . . . . . . . . . . . . . . . . . . . 16 Ansi Graphics . . . . . . . . . . . . . . . . . . . 16 Hang-Up . . . . . . . . . . . . . . . . . . . . . . 16 Local Echo . . . . . . . . . . . . . . . . . . . . . 16 Add line Feeds . . . . . . . . . . . . . . . . . . . 16 Break Signal . . . . . . . . . . . . . . . . . . . . 17 Ending a Telix Session . . . . . . . . . . . . . . . 17 Appendix A - Telix Command Summary . . . . . . . . . . 18 Appendix B - Telix.cnf, the Configuration File . . . . 19 Appendix C - Script Files . . . . . . . . . . . . . . 22 Appendix D - Telix.fon File Format . . . . . . . . . . 29 Documentation for the Telix communications program Page iii Telix v1.0 User Supported Software User Supported Software ----------------------- User supported software is a way of delivering quality software to the user at a reasonable cost, while allowing the user to make sure the software meets his needs. This concept is based on several ideals: The user should be able to try out the software before he pays for it. There is no reason users should have to use software that does not meet their requirements or does not live up to their expectations. Copying of programs should be encouraged, not discouraged. Sharing programs creates a feeling of goodwill among the users of a program. Also, in this way, this type of software can spread far more easily than software distributed by regular means. Under the user supported software concept, a user may request a copy of a program by sending a blank diskette and a self addressed, postage paid mailer to the manufacture of the program. A copy of the program will be sent to the user, including documentation. Included with the program will be a notice asking for a donation if the software meets the needs of the user. Registration is voluntary, but is encouraged. Registration is the user's way of supporting the author's work. Above all, whether or not you register, copy this program and distribute it to others for their non-commercial use. It is in this way that User Supported Software will succeed. Documentation for the Telix communications program Telix v1.0 Registration Registration ------------ If you use this program, please consider casting your vote for User Supported software, by registering you use of the program. Your donation will help keep me writing usefull quality software, and will give you a good feeling inside. Telix is going far, the list of improvements and additions is endless, but to keep on making these improvements I need your support. Registered users will receive mailers and notices of new versions of Telix as well as any new products I write. As weel, if any type of support is ever started, registered users will get preferred access to it. To register, send $20 US or $27 Canadian in the form of a check or money order to the following address: Colin Sampaleanu 276 Guildwood PKWY Scarborough, Ont. M1E 1P9 Along with this check or money order, include your name, address and phone number. Documentation for the Telix communications program Page 2 Telix v1.0 Introduction Introduction ------------ Program Description ------------------- Telix is a general purpose communications program that should be able to meet the needs of almost anyone. Telix features a powerful dialing directory, several file transfer protocols including Xmodem, Kermit, and Ymodem, extensive script files, keyboard macros, a scroll-back buffer, a dos shell, a session log, full path support, and menu other features. Above all, Telix is FAST. The Telix Philosophy -------------------- When we wrote Telix we kept several things in mind. We belive that a powerful program can still be simple to operate. We also believe that you don't have to give up speed in order to achieve this ease of use. We feel Telix has achieved these goals. Machine Requirements -------------------- Telix will run on an IBM PC, XT, AT, or compatible with at least 128k of free memory. This is memory available after dos has been loaded. Telix will support com port 1 or 2, any number of disk drives, and a printer connected to the parallel port. Telix Files ----------- Telix comes with a number of files and creates more in its normal operation. They include: Telix.exe - the main program Telix.ovl - the overlay file ConfigTX.exe - the Telix configuration program Telix.doc - the documentation file you are reading now convertf.exe - converts phone directories to Telix format Telix.fon - the phone directory file Telix.ld - the long distance codes file Telix.log - the defualt session log file Telix.key - the defualt keyboard macro definition file Start-Up Directory ------------------ When you run Telix it will remember the disk directory you ran it from. After this point, even if you have changed the current directory with the 'Change directory' command, Telix will know where Documentation for the Telix communications program Page 3 Telix v1.0 Introduction to look for its program files. It will look on the start-up directory for the needed file. Some files will also be written on this directory unless you specify another. If you set the environmental variable 'TELIX', Telix will have another (even better) way of knowing where to look for its files. The command form at the dos prompt is: set TELIX=pathname where pathname is a the legal dos pathname of the directory in which the Telix files are located. Please leave no space between the '=' and the arguements. For example, if you used 'set TELIX=c:\TELIX\', Telix would know to look for it's files in the Telix directory on drive C. This way, no matter where you run it from, Telix will always be able to find its files. To reset this environmental variable to nothing the command is: set TELIX= For more information on environmental variables see your PC/MS-Dos manual. Documentation for the Telix communications program Page 4 Telix v1.0 Program Features Program Features ---------------- Starting the Program -------------------- To start Telix tyep "telix" followed by RETURN while at the dos prompt. Upon starting, Telix will display a title screen for a perdiod of 25 seconds or until you press a key. Please read the message on the title screen carefully. After you are past the title screen, you will be in terminal mode unless Telix can't find the configuration file 'Telix.cnf', in which case it will run the configuration program 'ConfigTX'. Output String Translation ------------------------- Before we go any farther, the topic of output string translation must be discussed. In quite a few instances while using Telix, the user must specify a string to be sent out over the modem port. Sometimnes this string must contain characters which are not easilly printed on the screen, for example, control characters, and even pauses. There has to be a way of indicating these special characters, and it is done through the use of special charcters called translation characters. When these translation characters are encountered in an output string they are translated into other characters. The defualt translation characters are: | - when this is encountered in an output string a carriage return is sent out to the modem port instead. To really send the | chracter just use two of them, eg. || would send one | character. ^ - when this character is encountered in an output string it will make the following character a control character. eg. ^A will send out the code for Control-A. To send out the ^ character itself, use two ^'s, as explained above. ~ - when this character is encountered it will make Telix pause for 1/2 a second. There is no way to send the actual ~ character out. Two in a row will be converted to two pauses. These are the defualts, they can be changed to other characters with the configuration program, ConfigTX. There are a few things to keep in mind. These charcaters are only translated on strings sent out to the modem, for example, the dialing prefix, the hang-up string, a keyboard macro, the modem initialization string, and a few other cases. To send out two carriage returns you can not use two | characters in a row, as that would just send out the | character itself. You must use another method, such as the sequence ^M^M, since Control-M is the same as a carriage return. To send out the code for Escape, use ^[. ConfigTX - the Configuration Program ------------------------------------ Telix has many customizable features. These include things like Documentation for the Telix communications program Page 5 Telix v1.0 Program Features the screen setup, the communications paramters, and many other items. The default values for these paramters are stored in a file called 'Telix.cnf', the configuration file. Telix will automatically read this file upon starting up. If it can't find this file it will run the program 'Configtx', which will help you create a configuration file which meets your needs. ConfigTX can also be run at any time while in Telix's terminal mode by pressing Alt-O. When ConfigTX is run you will be shown a menu of five options: 1: Screen and colour 2: Modem and dialing 3: Filenames and paths 4: General settings 5: Kermit parameters 6: Save changes and exit 7: Exit to Telix/Dos The fisrt five options are paramter areas, the last two deal with leaving the program. Screen and Colour Settings The fist item of the main menu allows you to set the screen and colour defualts. After picking this option you will be shown a menu listing the various parts of the screen displays (eg. menu foreground colour). If you pick one of these items you will be allowed to scroll through the possible colours for it by using the arrow keys. When you have selected the right colour, press Return. If you want to leave the colours menu without selecting one press Esc. Another setting on the Screen and Colours menu is the screen write mode. If you pick this option you will be asked in which way you want Telix to write to the screen. This depends on the video adaptor present in your system.The first option is a direct screen write. This is the fastest mode, and should be used if you have a monochrome adaptor, and EGA adaptor, or an adaptor that never gets snow. The second option is a direct screen write with port checks. This method is slightly slower. You should use this method if you scrren gets snow on it or it flickers while executing the dos 'dir' command. One card with which you should use this is the color/graphics adaptor. The final method is a screen write with BIOS calls. You should use this method with applications like Topview. Finally, one last option in this menu is the help screen mode. The help screen is usually put on text page 2 so that it can be displayed instantly. This is not possible with monochrome adaptors, so Telix stores the help screen somewhere else if a mono adaptor is present. However, even with a color/graphics or EGA adaptor, using page 2 might be a problem if you want to use Topview, DesqView, or a similar system. The help screen mode option allows you to control the use of page 2. To stop Telix from ever using page 2, select option 1. To let Telix decide whether or not to use page 2, select option 2. And to make Telix always use page 2 for the help screen, select option 3. When you have finished picking the colours, select the 'Keep changes and exit' option if you want to keep the changes you have made, or the 'exit' option if you want to discard the changes. Modem and Dialing settings Documentation for the Telix communications program Page 6 Telix v1.0 Program Features Selecting the seconf option of the ConfigTX main menu shows a screenfull of defaults that Telix uses to control the modem and its output. To select a default value to change type its number and press Return. You will then be allowed to change it. Illegal values will be ignored. The parameters are: 1: The defualt communications parameters, including baud, data bits, parity, and stop bits. 2: The default communications port, either Com1 or Com2. 3: The modem initialization string. This string will be sent to the modem wehn Telix first starts. Different modems might need different strings. the defualt string is set up for Hayes compatible modems. It is: 'AT S11=55 S7=45 S0=0 V1 X1|' where: AT is the modem attention code. S11=55 is the dialing speed (touch tone, fast). S7=45 makes the modem wait 45 seconds for a connection. S0=0 turns off auto answer. V1 makes the modem respond with words. X1 makes the modem give extended results codes. | sends the terminating Return char to the modem. 4: The dialing prefix. This is the string Telix should send before the number when attempting to dial a number. eg. 'ATDT' for Hayes compatible modems. 5: The dialing postfix. The string Telix should send after the number when dialing. 6: The connect string. The string which the modem sends upon getting a connection. eg. 'CONNECT' 7: Busy strings. Up to four strings which the modem sends when it has failed to connect. eg. 'NO CARRIER', 'BUSY', etc. 8: The hang-up string. The string Telix should send to the modem to make it hang up. The defualt string works for Hayes compatible modems and is: '~~~+++~~~ATH0|'. There is an even faster and better way of hanging up MOST modems. This is done by dropping (turning off) a special signal called the DTR line. If you want Telix to hang-up by dropping the DTR line then set the hang-up string to equal 'DTR'. 9: Dial cancel string. The string Telix should send to the modem to cancel the current dialing attempt. On most modems all that is necessary is a Return character, '|'. 10: The dial time. The amount of time Telix should wait for a connection while dialing. This should usually be set to be greater than the amount of time the modem waits for the connection. 11: Redial pause. The number of seconds Telix should wait between attempts while redialing. 12: Local echo. Whether or not Telix should echo on the screen any characters you type. This should usually be off for bbs use. 13: Use xon/xoff handshaking. Whether or not Telix should use Documentation for the Telix communications program Page 7 Telix v1.0 Program Features the xon/xoff handshaking protocol while in terminal mode and during ascii file transfers. 14: Add line-feeds. Whether or not Telix should add line feeds to incoming carriage returns while in terminal mode and during ascii downloads. 15: Carrier Detect mask. To tell whether it is connected or not, Telix looks at the carrier detect signal on the RS-232 port. This CD mask tells it on which pin to look. The number should be a power of 2 (1, 2, 4, ..., 128). The default is 128. The three most common values are 16, 32, and 128. You should experiment with this number until Telix can correctly tell when you are connected. If the Hang-Up command tells you that hang-up failed, but you know it hasn't, then this value is wrong. Similarilly, if the connect status on the help/status screen is wrong, this value must be wrong. For some modems, there can be more than one valid number. Filnames and Path Settings The third option of the main menu allows you to change several filename and pathname defaults. They are: 1: Download directory. The directory on which Telix should save files which are downloaded. The user can of course overide this by giving a full pathname when prompted. 2: Script directory. The directory in which Telix should look for script files when trying to execute them. The user can overide this by using a full pathname in front of the filename when specifying it. 3: Defualt log file. The defualt log file Telix should use when saving a session log. The user can overide this. 4: The editor name. This should be the full pathname of the editor, including the extension of the name (EXE or COM). You need set this parameter only if you want to run your editor using the Run Editor command. eg. 'c:\editor.com'. General Settings The fourth option of the main menu allows you to change some general defualt settings. They are: 1: Ansi graphics status. If this is on ansi graphics will be on when you first run Telix. 2: Sound. If this is off Telix will not make ANY sounds. 3: Alarm sound. If this is off Telix will not make ANY alarm sounds, but will still beep when it receives the bell code from the host, unless the sound option is also off. 4: Keep downloads. If this is on, Telix will keep files which were aborted during a download. Otherwise Telix will delete these files. 5: Default file transfer protocol. This is the protocol Telix should have the menu bar on upon starting. As soon as any other protocol is selected while using Telix, that will become the default. 6: Show free space for downloads. This setting controls whether or not Telix will display the free space on the disk when you start a download. This option is provided because the Documentation for the Telix communications program Page 8 Telix v1.0 Program Features free space display takes a while for large hard disks. 7: Pause character. The character which when encountered in an output string should make Telix pause for 1/2 second. 8: Carrige Return character. The character which when encountered in an output string should make Telix send the code for Carriage Return. 9: Control code character. The character which when encountered in an output string should make Telix interpret the next charcater as a control charcater. Kermit Parameters For the moment there are no Kermit file transfer protocol paramters. The next release of Telix will have a variety of different parameters. Once you have picked your defualt options you can save them to the configuration file by selecting option four. After the file is saved you will be return to ither Telix or Dos depending upon where you ran ConfigTX from. If you do not want to save you changes then select option five to leave ConfigTX without saving your changes. Terminal Mode ------------- Immediately after starting Telix, and for most of the time while using it, you will be in Telix's terminal mode. While in this mode any normal (ascii) characters you type will be sent to the modem port, and any incoming characters will be printed on the screen. It is from the terminal mode that most Telix commands are initiated. Most commands are selected by pressing one or two special keys. For example, to access the dialing directory, you would press Alt-D. That is, while holding down the Alt key, you press the D key. Other commands need only one key. For example, to download files you must press the PgDn key. The Help/Status Screen While in terminal mode, pressing the Home key will switch you to a help screen showing you a summary of all the available commands. If the key for a command is pressed while the help screen is still on, it will be turned off and the command will be executed. On the right side of the help/status screen is some information regarding the status of the current connection and call. Items included are: the connect status, the current time and date, the current communications parameters, the state of the session log(s), and a few other items. The Dialing Directory --------------------- Telix allows you to keep 150 of your most often called numbers in a dialing directory. Besides the number, the remote location's name is stored, along with the communications setup or paramters Documentation for the Telix communications program Page 9 Telix v1.0 Program Features needed to talk to it. As well, a script file can be linked to a dialing entry so that if you successfully connect to that number the script file can auomatically log-on for you and perhaps even retrieve mail. To access the dialing directory press Alt-D while in terminal mode. A small window will appear, asking you to enter the entries to dial or to press Return to see the dialing directory. For the moment just press Return. This first window is just a very quick way to dial your most commonly called numbers. Once you have pressed Return the dialing directory will appear. Most of the scrren is taken up by a window showing 15 of the 150 entries in the dialing directory. In the bottom left-hand corner is a menu of options. To scroll through the dialing directory use PgUp to go back 15 entries at a time, PgDn to go forward 15 entries, Home to go to the beginning of the directory, and End to go to the end of the directory. At the same time you are free to pick an option from the options menu. This menu deals mainly with dialing choices. To see another menu which deals with dialing directory revision choices, select the option called 'Other options'. It should be emphasized that whenever the words 'Use Home, End, PgUp, and PgDn to view the dialing directory' are visible you may scroll through the directory. Revising an Entry To revise a dialing entry first select the option called 'Other options' while at the frist dialing directory menu. You will be shown a menu dealing with various kinds of revisions you can make to the dialing directory. To revise an entry select 'Revise entry'. You will be asked the entry to revise. Once you select it a window will appear with the old version of the entry. You will be asked for a new name. It can be a maximum length of 29 characters. You will then be asked for the new phone number. Just enter the number itself, it will be automatically shifted to the right. You will then be asked for the new communications paramters, including baud, parity, data bits, and parity. Finally you will be asked what script file you want to link to this entry. If you do not want to link any, press Return. Pressing Esc while in any part of this process will get you out without any changes being made. Clearing an Entry To delete an entry or a range of entries now select 'clear entry' from the secondary menu of the dialing directory. You will be asked the range of entries that you want to delete. You will also be asked to confirm your choice. If you agree to it, the selected entries will be cleared back to empty entries. Revising Long Distance Codes To revise the Long Distance codes, select the option called 'LD codes' at the secondary dialing directory menu. There are four Long Distanc code characters: ! @ - +. When you place one of them in front of a number to dial, it will be expanded to a string. For example you could have the plus sign '+', be expanded to the digits 99-0089, or whatever string you specify. After selecting this option you will be shown a menu of the available long Documentation for the Telix communications program Page 10 Telix v1.0 Program Features distance codes. Selecting a character to modify will show you the current string assigned to it. You can trhen enter a new string for it. After you have made your changes, you must save them to disk if you want to keep them every time you run Telix. To save them to disk select the 'save changes' option. Searching for an Entry To serach for a particular entry in the dialing directory select 'Find entry' from the main dialing directory menu. You will be asked to give the string to search for. If Telix finds the entry with that string in it, that entry will be highlighted. If while searching for the string Telix reaches the end of the directory, it will wrap around to the beginning and continue the search. If the string still can not be found Telix will say 'Sorry, string not found'. If you want to search for the same string as last time, just press Return when asked for the string to search for. Dialing a Number To dial a number select 'Dial number' from the main dialing directory menu. You will be asked to enter the directory entry to dial. While you are entering this information you can also scroll through the directory as described above. You may also place up to 3 Long Distances codes in front and one Long Distance code after the entry number. For example '+21!' would send the string for the '+' long distance code, followed by the number from entry 21, followed by the string for Long Distance coide '!'. To dial up to 10 numbers one after another in an endless loop until a connection is made, select 'Dial sequence'. You should enter up to 10 entries to dial, in exactly the same format as described above, separated by a space between each. The numbers will be redialed in sequence. To learn more about redialing see the instructions for the redial function below. Sometimes you may want to dial a number that is not in the dialing directory. To do this select 'Manual dial'. You will be asked to give a number to be sent to the modem. Whatever you supply will be sent out exactly as is, except for Long Distance codes, which are still valid. Automatic Redial ---------------- Telix allows you to automatically redial a sequence of numbers over and over again until a connection is established. If you enter a list of entry numbers to dial with the 'Dial Sequence' option of the main Dialing Directory menu, or if you enter a sequence of entry numbers to dial immediately after pressing Alt-D, Telix will start Redialing those numbers. Telix will keep you informed of the current status, and you will be alerted when a connection is established. To redial the numbers you entered previously press Alt-R while in the terminal mode. When a connection is established that number is taken out of the list of numbers to dial. If later you type Alt-R to redial the previous list that number will no longer be dialed. As well, while Documentation for the Telix communications program Page 11 Telix v1.0 Program Features redialing, you have the option of changing the time that Telix waits for a connection, and also the option of deleting a number from the list to dial, by pressing 'T' and 'D' respectively. File Transfers -------------- Sending files from one computer to another is one of the most useful things you can do with your modem. Telix supports a full assortment of the most popular file transfer protocols, including Xmodem, Kermit, Telink, Ascii, and Ymodem. Telix's file transfers are very fast, beating most programs by quite a margin. Telix also has very low overhead time, so as the speed of a file transfer increases, Telix's time compared to other programs decreases. All file transfers use a 10 Kbyte buffer, and full error detection is standard. Downloading Files To start downloading (receiving) a file from a remote host, you must usually inform the remote host of the files that you want it to send to you. You must then start the download on the Telix side. Pressing the PgDn key will display a menu asking which file transfer protocol you would like to use. If you have selected Xmodem, Ascii, or Ymodem as the protocol, Telix will ask you for the filename to save the file to. Any legal dos filename is valid, including a path. If the filename you supply already exists, Telix will ask you to confirm your choice or give another filename. If you select Kermit or Telink the remote host will supply the name to save the file to. During the transfer, a full status window will be displayed showing the elapsed time as well as the number of bytes received. For ascii transfers, a status window is not displayed, only a single status line at the top of the screen. To abort a file transfer at any time press the Escape key. Uploading Files To start uploading (sending) a file to a remote host you must also usually inform the host of the file you will be sending it. To start the upload on the Telix end press the PgUp key. This will display a menu asking you which file transfer protocol you want to use to send the file. After you have selected the protocol, you will be asked for the file(s) to send. During the file transfer, a full status window is displayed, unless you are using Ascii protocol, in which case only a status line is displayed. Information shown is the expected time the transfer will take, the time remaining, the number of bytes to send, and the number of bytes left. To abort a transfer at any time press the Escape key. File Transfer Protocols Xmodem - This is by far the most popular protocol in use today, but it is slowly being replaced by more sophisticated protocols. Xmodem sends files in blocks of 128 characters at a time. When the receiving computer is satisfied that the block has arrived intact, it signals so and waits for the next block. Error Documentation for the Telix communications program Page 12 Telix v1.0 Program Features checking is a checksum or Cyclic Redundancy Check. Telix supports both and will automatically use the right one. During a download, Telix will attempt to use the CRC, but will switch to checksum if it seems the host does not support CRC. The Xmodem protocol also needs a setup of no parity, 8 data bits, and 1 stop bit. If you're communicatins parameters are different from these when you start an Xmodem transfer, Telix will switch to the required setup for the transfer, and back to the original setup after it is finished. Ascii - in an Ascii transfer, it is as if the sender is actually typing the characters and the receiver is just recording them. There is no form of error detection used. Usually only ascii files can be sent in this way, as binary files contain characters which would foul-up the screen. Ymodem - The Ymodem protocol is exactly the same as the Xmodem protocol except that block sizes of 1024 characters as opposed to 128 characters are supported. Telink - This protocol is mainly found on Fido bbs systems. It is basically the Xmodem protocol using CRC checking with an extra block sent ahead of the file teliing it's name, size, and date. This is more convenient for the receiver, as he no longer has to supply the filename. Relaxed Xmodem - Certain hosts cannot maintain the strict timing required to transfer a file using the Xmodem protocol. Relaxed Xmodem is exaclty the same as Xmodem except that all the timing is multiplied by a factor of ten. Where Xmodem might wait 2 secondsfor a character, Relaxed Xmodem will wait 20 seconds. Kermit - The Kermit protocol is in a class of its own. It uses packets of up to 94 characters to send the file. It was developed to make it easier for computers to send files to each other. Almost any computer using Kermit can be set up to send files to another computer using Kermit, no matter what their type. The Kermit protocol implemented in Telix can be tailored to the user's needs in the configuration program, ConfigTX. Script Files ------------ Script files are ascii files containing sequences of commands for Telix to follow. They can do many usefull things like automatically logging on to a host, setting up special parameters, performing unnatended file transfers, and many other tasks. They can be linked to a dialing entry so that they are run automatically upon a connection. To run a script file press Alt-S. You will be prompted for the name of the script file. Any name is fine, including a path. If no extension is given, 'scr' is assumed. If a special directory where script files are to be found has been defined, Telix will look there for script files, unless a path is given. To define this script directory run the configuration program ConfigTX. To see how to write your own script files, refer to the appendix describing their structure. Documentation for the Telix communications program Page 13 Telix v1.0 Program Features While script files are executing, if Telix is waiting for a string from the host, any charcaters you type will be sent to the host, so that you can still have some input. As well, the script can prompt you for text to send. To abort a script file while it is executing, press the Esc key. You will often have to press this key twice, once to abort the current function, and a second time to abort the script. You will be asked to confirm this action. Keyboard Macros --------------- Keyboard macros are special key definitions that can make often repeated actions like typing your name a lot easier. Any of the function keys, as well as their Shifted, Control, and Alt versions can be set up to send a string to the remote system when pressed. To change the current function key definitions, press Alt-M. A window will be displayed asking you which set of keys to change or which macro file to load. To load a new keyboard macro file select that option and supply the name of the macro file. If no extension is given, 'key' is assumed. To change a function key definition, first select the group of keys it is in (Regular, Shifted, Control, and Alt). then select the individual key, F1 through F10. When prompted, type in the new string. Control characters, pauses, and Returns can be included in the definition in the manner described previously in the manual under Output String Translation. If you have made any changes, you will be prompted if you want to save them to disk when you leave the Change Keyboard Macro function. Dos Shell --------- Pressing Alt-J will let you jump to a dos shell. You will see the Dos prompt and will be able execute any Dos command, for example 'dir'. If there is enough memory left, you can even run programs. To exit the Dos shell type 'exit' and press Return. You will be back in Telix with the screen undisturbed from before your jump to the shell. In order to run the Dos shell, there must be enough memory left, and Telix must be able to find the file called 'Command.com'. If either of these requirements is not met, Telix will tell you so. Editor ------ Pressing Alt-A will allow you to run your favourite editor from within Telix. In order to do this you must run the configuration program ConfigTX and supply the full name and path of your editor. As well, there must be enough memory left in the computer. Dos and File Functions ---------------------- Documentation for the Telix communications program Page 14 Telix v1.0 Program Features Pressing Alt-F will display a menu of some common Dos operations. For convenience, a few commands available elsewhere have been included. The commands available are: 1: Jump to Dos Shell - exactly the same as the Alt-J command. 2: Files directory - you will be prompted for the optional filespec, for example '*.doc'. If you want to list all the files then just press Return. 3: Change current directory - the current directory is displayed and you are asked to enter a new one. Use the same format as for the Dos 'CHDIR' command. 4: Change current drive - the current drive is entered and you are asked to enter the new drive. 5: Delete file - you are asked to eneter the filename of the file to delete. 6: Run editor - exaclty the same as the Alt-A command. Session Logging --------------- Telix allows you to keep a full record of all transactions over the modem, to either a log file or to the printer. The log records every character that comes in, except for those that are erased by backspaces (up to the beginning of a line). To turn the printer log on and off use the Ctrl-PrtSc key combination. Pressing these keys while the printer log is off will turn it on. Pressing them while the printer log is on will turn it off. If the printer is not ready to receive characters, Telix will tell you. To start a session log to a disk file press Alt-L. You will be prompted for the filename to save the log to. Press Return to use the defualt filename. All data is added to the end of the file if it exists already. To turn off the log press Alt-L again. Pressing Ctrl-@ will temporarilly put the log on hold until you press Ctrl-@ again or turn off the log. While the log is on hold any characters received are not saved to the file. Scroll-Back ----------- To review the past several screens of characters press Alt-B. You will be in the Scroll-Back display. You will be able to move through the last six thousand characters received by using the arrow keys to scroll line by line, the Home and End keys to go to the beginning and end of the buffer, and the PgUp and PgDn keys to move through the buffer a page at a time. To find a certain string in the buffer press 'F'. Telix will prompt for the string to search for. If the string is found the line containing it will be placed at the top of the screen. To search for the same string as last time press Return when asked for the search string. To save the screen image to a file press 'I'. Telix will prompt you for the file to save the image to. If the file already exists, the screen image will be appended to it. To print out a screen image Documentation for the Telix communications program Page 15 Telix v1.0 Program Features to your printer press Shift-PrtSc. Clear Screen ------------ To clear the screen press Alt-C. The screen will be cleared to the defualt colours, and the cursor will be placed in the upper left-hand corner. Ansi Graphics ------------- Ansi graphics are special codes sent by remote systems to control your screen. They can be used to display colourful text pictures as well as for controlling the cursor. Telix has built-in support of Ansi Graphics, there is no need to run any special driver. Pressing Alt-G will toggle Telix's recognition of Ansi Graphics codes on and off. If Ansi Graphics codes are sent and you have the option turned off the incoming characters will look like garbage. Hang-Up ------- Pressing Alt-H will make Telix attempt to hang-up the modem. Telix will send the special hang-up string defined in ConfigTX to the modem. If the hang-up string is 'DTR', Telix will attempt to hang-up the modem by dropping the DTR line. If the hang-up attempt is unsuccessful and Telix detects that you are still connected, Telix will warn you. Local Echo ---------- Pressing Alt-E will toggle local echo on and off. If local echo is on characters you type are printed on the screen. If local echo is off characters you type are not printed on the screen, they must be sent back to you by the remote host to be printed by the screen. Most hosts are set up so that local echo should be off; they will do the echoing. Often when talking to another user however, local echo must be turned on to see the characters you type. Add Line Feeds -------------- Usually when you type a Carriage Return character, it is sent out by itself. sometimes however, to work with a host, it is neccessary that Line-Feed characters are sent out with Carriage Returns. Pressing Shift-Tab will toggle the adding of Line-Feed characters. If this option is on, every time you type a Return, a Line-Feed is sent out immediately behind it. Documentation for the Telix communications program Page 16 Telix v1.0 Program Features Break Signal ------------ Some hosts require the use of a special signal called a Break signal to do certain tasks like end transmissions. To make Telix send a Break signal to the remote host press Ctrl-End. Ending a Telix Session ---------------------- To exit the Telix program, press Alt-X. Telix will ask you if you really want to quit. Press 'Y' to confirm the exit, 'N' or Esc to return to Telix. When Telix ends a session and returns to dos, it checks the state of the connection. If Telix sees that you are connected to a host system, it will not drop a special signal on the RS-232 port, called the DTR line. This will allow you to stay connected. If Telix sees that you aren't connected, it will drop this signal. Documentation for the Telix communications program Page 17 Telix v1.0 Command Summary Appendix A - Telix Command Summary Major Commands -------------- Alt-B Scroll Back Alt-D Dialing options Alt-F Dos and File options Alt-M Keyboard Macros Alt-O Run cOnfigtx Alt-P Com Paramters Alt-R Redial last # Alt-S Run Script file Alt-X Exit Telix PgUp Upload (send) files PgDn Download (receive) files Secondary Functions ------------------- Alt-A Run editor Alt-C Clear screen Alt-E Toggle local echo Alt-G Ansi Graphics on/off Alt-H Hang-up modem Alt-J Jump to dos shell Alt-L Session Log on/off Ctrl-@ Log hold on/off Ctrl-PrtSc Printer log on/off Ctrl-End Send break signal Shift-Tab Add line-feeds on/off All of these commands should be entered while in terminal mode. Many will prompt you for further courses of action. Documentation for the Telix communications program Page 18 Telix v1.0 Telix.cnf, the Configuration File Appendix B - Telix.cnf, the Configuration File The file 'Telix.cnf' consists of a series of default parameters which are used to customize Telix to your own needs. This file is automatically read in by Telix upon start-up. If it is not there, the program 'ConfigTX' is automatically run from within Telix. ConfigTX allows you to change the default paramters and will then write out the Telix.cnf file, using the new paramters. ConfigTX can also be run from within Telix at any time using the Alt-O command. The Telix.cnf file is a regular ascii file. One paramter is allowed per line. Lines longer than 80 characters will be cut off at that point. Lines should end in line-feeds or CR/LF. Comments should start with '.', ';', or '/'. Be warned however, that comments will be overwriten the next time you update the file with ConfigTX. Each setting takes the form 'parameter=setting'. The parameter to be changed is given, followed by an equal sign, followed by the new setting. Illegal values will be ignored. A few example are: baud=1200 addlf=off dpref="ATDT" busy1="NO CARRIER" The case of the commands does not matter. Strings must be enclosed in quotes only if the contain spaces, tabs, or comment characters. If you want tu use a quote character in a quoted string repeat the quote, eg 'can''t'. If you are unclear about the syntax of any of these settings take alook at the actual configuratin file. Finally, there is really no reason you should know all of these parameters, because the configuration program will save the file. However these paramters are also used with the Set command in Telix script files. Legal Parameters - numbers in brackets are valid ranges ---------------- Communication parameters: baud - the speed Telix should use. Valid speeds are: 300, 1200, 2400, 4800, 9600, and 19200. parity - the type of parity Telix should use. = N: none = E: even = O: odd data - the number of data bits Telix should use (7 or 8) stop - the number of stop bits Telix should use (1 0r 2) port - the communications port Telix should use (1 or 2) Screen settings: swmode - the screen write mode Telix should use. = 1: Use direct screen writes with no port checks, = 2: Use direct screen writes with port checks (for screens that get snow). = 3: Use bios calls (for applications like TopView). helpmode - the help screen mode Telix should use. = 1: Never use display page 2 for the help screen. = 2: Use display page 2 for the help screen if Telix thinks it's okay to do so. Documentation for the Telix communications program Page 19 Telix v1.0 Telix.cnf, the Configuration File = 3: Always use page 2 for the help screen. back - screen background colour (0 - 7) fore - screen foreground colour (0 - 15) bord - screen border colour (0 -15) mbord - menu border colour (0 - 15) mbback - menu border background colour (0 - 7) mfore - menu froeground colour (0 - 15) mbold - menu bold item colour (0 - 15) mback - menu background colour (0 - 7) mbar - menu bar colour (0 - 7) msel - menu item selected under bar colour (0 -15) Modem and dialing settings: minit - the modem initialization string. dpref - the string sent before the number when dialing. dpost - the string sent after the number when dialing connect - the string sent by the modem when it has connected busy1 - string sent by modem if the line is busy (#1) busy2 - " " " " " " " " " (#2) busy3 - " " " " " " " " " (#3) busy4 - " " " " " " " " " (#4) mhang - the string to send to the modem to hang it up dcancel - string to send to cancel current attempt while dialing dtime - number of seconds to wait for connection while dialing (1 - 999) ptime - number of seconds to pause between attempts while dialing (1 - 999) cdmask - the modem Carrier Detect mask Telix should use to see if there is a connection. This number should be a power of 2. echo - local echo. = On: local echo on = off: local echo off xonxoff - use of xon/xoff handshaking = On: use xon/xoff = Off: do not use xon/xoff addlf - add line-feeds to incoming carriage returns = On: add line-feeds = Off: do not add line-feeds Output string characters: pausechar - the character which Telix should interpret to mean a 1/2 second pause in output strings. The value should be in readable form, eg. 'pausechar = ~'. retchar - the character which Telix should interpret as a Carriage Return. ctrlchar - the charcater which should mean theat the next char. is a control char. Filenames and paths: downdir - the directory where downloaded files should be saved scriptdir - directory where script files should be searched for editor - full pathname of editor including extension (com or exe) logfile - the defaul log file filname General settings: ansi - On or Off. Whether or not Telix should understand Ansi Graphics. Documentation for the Telix communications program Page 20 Telix v1.0 Telix.cnf, the Configuration File sound - On or Off. Controls whether or not Telix makes ANY sound. alarm - On or Off. Controls whether or not alarm sounds are heard. keepaborted - aborted download file status. = On: Telix keeps aborted download files. = Off: Telix deletes aborted download files. protocol - the default file transfer protocol upon startup. Should be the same as the number in the actual transfer function, eg '1' to mean Xmodem. showfree - On or Off. Controls whether or not Telix shows the free space on the disk when starting a download. Documentation for the Telix communications program Page 21 Telix v1.0 Script Files Appendix C - Script Files Script files are ascii text files containing commands for Telix to follow in succession. Script files can do many usefull things, for example automatically dialing a bbs sytem, getting any mail, transfering files, and then logging off the sytem, all without any human intervention. There is a script command equivalent to almost any option available while in the terminal mode, and there are many others as well. Script files can be run in one of two ways: they can be linked to a dialing directory entry and automatically run when you connect to that system, and by using the Run Script file (ALt-S) command. Script files usually have the ending '.scr', but this is optional, any legal filename is fine. When running a script, the extension 'scr' is assumed unless another extension is given or just a period is given as the extension, eg 'script.'. To abort script execution, press the Esc key. You will often have to press it twice, once to abort the current function, and the second to abort the script file. You will be asked to confirm this action. This appendix consists of: 1: Short script command summary 2: Script file rules 3: Long descriptions of script commands Documentation for the Telix communications program Page 22 Telix v1.0 Script Files Script File Command Summary (Alphabetically by command) Command form Command Function -------------------------------------------------------------------- Break Send break signal (Ctrl-End) CHDIR "pathname" Change current direcotry Clear Clear screen (ALT-C) Delay nnn Stop program for nnn 1/10th seconds. Dial "dir. number(s)" Dial numbers from directory (Alt-D) Dos "command" Dos command or dos shell if no command DosFunction Call up Dos Functions (Alt-F) menu Drive "drive" Change current drive Download type "filename" Download filename using type protocol HangUp Hang-up modem (ALT-H) IfNQuery label "question" Goto label if user answers 'N' to ques. IfOffline label Jump to label if no carrier detected IfOnline labe Jump to label if carrier detected IfYQuery label "question" Goto label if user answers 'Y' to ques. KeyMac "filename" Load macro file LHoldOff Trun off log hold LHoldOn Turn on log hold Message "string" Send string to local screen with C/R OffLog Trun off session log if it is on OnLog "filename" Turn on session log to filename OffPLog Trun off printer (Shift-PrtSc) OnPLog Trun on printer (Shift-PrtSc) ReDial "dir. number(s)" Redial numbers from directory (Alt-R) RunConfig Run the ConfigTX program (ALT-O) ScrollBack Goto the scroll-back function (Alt-B) Send "string" Send string to the remote system Set param=setting Sets parameter using cnf file format Stop Stop executing this script file Timeout time label Turn on timeout for wait functions, after time seconds, and goto label if time out. WaitAny Wait for any charcters from remote WaitFor "string" Wait for string from remote Upload type "filename" Upload filename using type protocol Documentation for the Telix communications program Page 23 Telix v1.0 Script Files Script File Rules: 1: File is a normal ascii text file (readable by any text editor). 2: One command per line is allowed. 3: Labesl must preceed commands if there are any must end in a ':'. eg. 'mylabel:'. 4: Lines longer than 80 chars will be truncated at that position. 5: Argument strings do nat have to be in quotes unless they include spaces, tabs, or comment characters. If in doubt, use quotes! Either ticks ('), or double quotes ("), are allowed. If you use quotes around a string but want to use quotes in the string, use two quotes instead of one like this: 'can''t'. 6: Strings can not go past the end of the line and can not be longer than 64 characters. 7: Comments start off with a '.', ';', or a '/'. A blank line is considered a comment. Any text after a comment will be ignored. If you want to execute a command using a string with a comment character in it, enclose the string in quotes. eg. hello;goodbye becomes "hello;goodbye". Documentation for the Telix communications program Page 24 Telix v1.0 Script Files Script Commands in Depth Break This will send a sustained break signal over the modem port, like the Ctrl-End command. CHDIR "directory" The directory will be changed to the given string, if no string is given, the user will be prompted as in the change directory function of the dos function menu. Clear This command will clear the screen, like the ALT-C command. Delay nnn This will make Telix wait for the specified number of tenths of seconds (1 - 30000). All processing will stop. Dial "dir. number(s)" The indicated dialing directory numbers are dialed. If none are specified, then the then the dialing menu is presented, like the Alt-D command. Dos "command" The dos command is executed. If no command is given Telix will drop into a dos shell like the Alt-J command. Also, make sure if you run a program that expects input that you are on hand to give it. DosFunction This command will make Telix go to the Dos Function menu, like the Alt-F command. Drive "drive" The current drive will be changed to the drive given, for example 'drive "A"' or 'drive "a:"' will change the current drive to A. Download type "filename" The specified file will be downloaded using 'type' prtocol. Type can be: AS - Ascii XM - Xmodem XR - Xmodem relaxed TE - Telink YM - Ymodem KE - Kermit If the filename is missing the user will be prompted for it. If Both the transfer type and the filename are missing, the user will be prompted for them. This command is like the PgDn command. Documentation for the Telix communications program Page 25 Telix v1.0 Script Files HangUp This will hang up the modem, exactly like the Alt-H command. IfNQuery label "question" A pop-up window appears asking "question". If the user presses 'N' execution continues at the given label. If the User presses 'Y', nothing happens. IfOffline label If no carrier signal is detected script file execution will continue at the given label. IfOnline label If a carrier signal is detected script file execution will continue at the given label. IfYQuery label "question" A pop-up window appears asking "question". If the user presses 'Y' execution continues at the given label. If the User presses 'N', nothing happens. KeyMac "filename" This command will load the indicated keyboard macro definition file. If no filename is give the Keyboard macro command (Alt-M) will be run. LHoldOff This command will turn the log hold off, like the Ctrl-@ commnad. LHoldOn This command will put the log on hold, like the Ctrl-@ command. Message "string" This will print the string on the user's screen. A carriage return is automatically appended to the string. OffLog This will turn off the session log and update it, just like pressing Alt-L when the log is on. OnLog "filename" This will open a session log to the given filename. If no filename is given the user will be prompted, like the Alt-L command. OffPLog Documentation for the Telix communications program Page 26 Telix v1.0 Script Files This will turn off the log to the printer, if it currently on. OnPLog This will trun on the log to the printer. ReDial "dir. number(s)" The indicated dialing directory numbers are redialed. If none are specified, then the last number(s) specified are redialed, like the Alt-R command. RunConfig This command will run the configuration program, ConfigTX, just like the Alt-O command. ScrollBack This command will call up the Scroll-Back function, like the Alt-B command. Send "string" The given string is sent over the modem port. All output string characters are supported. Set param=setting Using this commnad you can change the settings of all the Telix paramters, EXACTLY like the cnf file, and using the same fromat. For example, to change the baud to 1200, you would use: set baud=1200 Any of the paramters that can be put in a cnf (configuration) file can be changed with the set command. Stop This command will make the execution of this script file stop, as if the end of it had been reached. Timeout time label There are a few script ccommands that wait for a string or character from the remote or (other) end of the connection. Usually, these commnads will wait indefinitely, but using the Timeout command you can make Telix do something else if the string or charcter doesn't appear in time. The time argument says how long these commands should wait for (1 - 30000 seconds), and the label says where to jump to if this time has elapsed. When the script first starts executing, timeout is off, it will be truned on if both a time and a label are given. After that if only the time is given in a subsequent Timeout commnad, Telix will still go to the old label if the time is up. Using the timeout command with no arguments will turn off the timeout function, and commands will wait forever again for remote input. Documentation for the Telix communications program Page 27 Telix v1.0 Script Files WaitAny This command will pause Telix untilk any character is received from the remote connection. If timeout is on and time runs out Telix will jump the the label given in the timeout commnad. WaitFor "string" This command will wait until the given string is received from the remote connection. If timeout is on and time runs out Telix will jump to the label given in the Timeout commnad. The case of the string dos NOT matter. Upload type "filename" The specified file will be uploaded using 'type' prtocol. Type can be: AS - Ascii XM - Xmodem XR - Xmodem relaxed TE - Telink YM - Ymodem KE - Kermit If the filename is missing the user will be prompted for it. If Both the transfer type and the filename are missing, the user will be prompted for them. This command is like the PgUp command. Documentation for the Telix communications program Page 28 Telix v1.0 Telix.fon File Format Appendix D - Telix.fon File Format The phone directory file 'Telix.fon' is a regular ascii file. It is made up of 150 lines each ending in CR/LF. If the file is to be used by Telix this format must be followed exactly. Each line is 68 characters long including the CR/LF, for a total length of 10200 bytes. All the paramters are in string form, and can be seen if the file is typed. Following is an example entry and the offsets of the various fields. As can be seen, there are spaces between some, but not all fields. Sample entry: "My Favourite BBS 1-800-267-3701 1200N81 | |Myscript.scr\r\n"; The | means the line has been broken there so it would fit in this doc file. '\r' means return, '\n' means line-feed. Field Offset Length name 0 29 number 30 14 baud 45 5 parity 50 1 data bits 51 1 stop bits 52 1 script 54 12 The phone number can be anywhere in its field. Telix will print it as far right as possible. The baud should be placed as far right as possible in its field. Documentation for the Telix communications program Page 29 A can be changed with the set command. Stop This command will make the execution of this script file stop, as if the end of it had been reached. Timeout time label There are a few script ccommands that wait for a string or character from the remote or (other) end of the connection. Usually, these commnads will wait indefinitely, but using the Timeout command you can make Telix do something else if the string or charcter doesn't appear in time. The time argument says how long these commands should wait for (1 - 30000 seconds), and the label says where to jump to if this time has elapsed. When the script first starts executing, timeout is off, it will be truned on if both a time and a label are given. After that if only the time is given in a subsequent Timeout commnad, Telix will still go to the old label if the time is up. Using the timeout command with no will turn off the timeout function, and commands will wait forever again for remote input. Documentation for the Telix communications program Page 27 Telix v1.0 Script Files WaitAny This command will pause Telix untilk any character is received from the remote connection. If timeout is on and time runs out Telix will jump the the label given in the timeout commnad. WaitFor "string" This command will wait until the given string is received from the remote connection. If timeout is on and time runs out Telix will jump to the label given in the Timeout commnad. The case of the string dos NOT matter. Upload type "filename" The specified file will be uploaded using 'type' prtocol. Type can be: AS - Ascii XM - Xmodem